/*
 * SPDX-License-Identifier: GPL-2.0-only
 */

/*
 * ethtool.h: Defines for Linux ethtool.
 *
 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
 *                                christopher.leech@intel.com,
 *                                scott.feldman@intel.com)
 * Portions Copyright (C) Sun Microsystems 2008
 */

#pragma once

#include <stdint.h>

/* This should work for both 32 and 64 bit userland. */
struct ethtool_cmd {
    uint32_t    cmd;
    uint32_t    supported;  /* Features this interface supports */
    uint32_t    advertising;    /* Features this interface advertises */
    uint16_t    speed;      /* The forced speed, 10Mb, 100Mb, gigabit */
    uint8_t duplex;     /* Duplex, half or full */
    uint8_t port;       /* Which connector port */
    uint8_t phy_address;
    uint8_t transceiver;    /* Which transceiver to use */
    uint8_t autoneg;    /* Enable or disable autonegotiation */
    uint8_t mdio_support;
    uint32_t    maxtxpkt;   /* Tx pkts before generating tx int */
    uint32_t    maxrxpkt;   /* Rx pkts before generating rx int */
    uint16_t    speed_hi;
    uint8_t eth_tp_mdix;
    uint8_t reserved2;
    uint32_t    lp_advertising; /* Features the link partner advertises */
    uint32_t    reserved[2];
};

static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
                                         uint32_t speed)
{

    ep->speed = (uint16_t)speed;
    ep->speed_hi = (uint16_t)(speed >> 16);
}

static inline uint32_t ethtool_cmd_speed(struct ethtool_cmd *ep)
{
    return (ep->speed_hi << 16) | ep->speed;
}

#define ETHTOOL_FWVERS_LEN  32
#define ETHTOOL_BUSINFO_LEN 32
/* these strings are set to whatever the driver author decides... */
struct ethtool_drvinfo {
    uint32_t    cmd;
    char    driver[32]; /* driver short name, "tulip", "eepro100" */
    char    version[32];    /* driver version string */
    char    fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
    char    bus_info[ETHTOOL_BUSINFO_LEN];  /* Bus info for this IF. */
    /* For PCI devices, use pci_name(pci_dev). */
    char    reserved1[32];
    char    reserved2[12];
    /*
     * Some struct members below are filled in
     * using ops->get_sset_count().  Obtaining
     * this info from ethtool_drvinfo is now
     * deprecated; Use ETHTOOL_GSSET_INFO
     * instead.
     */
    uint32_t    n_priv_flags;   /* number of flags valid in ETHTOOL_GPFLAGS */
    uint32_t    n_stats;    /* number of u64's from ETHTOOL_GSTATS */
    uint32_t    testinfo_len;
    uint32_t    eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
    uint32_t    regdump_len;    /* Size of data from ETHTOOL_GREGS (bytes) */
};

#define SOPASS_MAX  6
/* wake-on-lan settings */
struct ethtool_wolinfo {
    uint32_t    cmd;
    uint32_t    supported;
    uint32_t    wolopts;
    uint8_t sopass[SOPASS_MAX]; /* SecureOn(tm) password */
};

/* for passing single values */
struct ethtool_value {
    uint32_t    cmd;
    uint32_t    data;
};

/* for passing big chunks of data */
struct ethtool_regs {
    uint32_t    cmd;
    uint32_t    version; /* driver-specific, indicates different chips/revs */
    uint32_t    len; /* bytes */
    uint8_t data[0];
};

/* for passing EEPROM chunks */
struct ethtool_eeprom {
    uint32_t    cmd;
    uint32_t    magic;
    uint32_t    offset; /* in bytes */
    uint32_t    len; /* in bytes */
    uint8_t data[0];
};

/* for configuring coalescing parameters of chip */
struct ethtool_coalesce {
    uint32_t    cmd;    /* ETHTOOL_{G,S}COALESCE */

    /* How many usecs to delay an RX interrupt after
     * a packet arrives.  If 0, only rx_max_coalesced_frames
     * is used.
     */
    uint32_t    rx_coalesce_usecs;

    /* How many packets to delay an RX interrupt after
     * a packet arrives.  If 0, only rx_coalesce_usecs is
     * used.  It is illegal to set both usecs and max frames
     * to zero as this would cause RX interrupts to never be
     * generated.
     */
    uint32_t    rx_max_coalesced_frames;

    /* Same as above two parameters, except that these values
     * apply while an IRQ is being serviced by the host.  Not
     * all cards support this feature and the values are ignored
     * in that case.
     */
    uint32_t    rx_coalesce_usecs_irq;
    uint32_t    rx_max_coalesced_frames_irq;

    /* How many usecs to delay a TX interrupt after
     * a packet is sent.  If 0, only tx_max_coalesced_frames
     * is used.
     */
    uint32_t    tx_coalesce_usecs;

    /* How many packets to delay a TX interrupt after
     * a packet is sent.  If 0, only tx_coalesce_usecs is
     * used.  It is illegal to set both usecs and max frames
     * to zero as this would cause TX interrupts to never be
     * generated.
     */
    uint32_t    tx_max_coalesced_frames;

    /* Same as above two parameters, except that these values
     * apply while an IRQ is being serviced by the host.  Not
     * all cards support this feature and the values are ignored
     * in that case.
     */
    uint32_t    tx_coalesce_usecs_irq;
    uint32_t    tx_max_coalesced_frames_irq;

    /* How many usecs to delay in-memory statistics
     * block updates.  Some drivers do not have an in-memory
     * statistic block, and in such cases this value is ignored.
     * This value must not be zero.
     */
    uint32_t    stats_block_coalesce_usecs;

    /* Adaptive RX/TX coalescing is an algorithm implemented by
     * some drivers to improve latency under low packet rates and
     * improve throughput under high packet rates.  Some drivers
     * only implement one of RX or TX adaptive coalescing.  Anything
     * not implemented by the driver causes these values to be
     * silently ignored.
     */
    uint32_t    use_adaptive_rx_coalesce;
    uint32_t    use_adaptive_tx_coalesce;

    /* When the packet rate (measured in packets per second)
     * is below pkt_rate_low, the {rx,tx}_*_low parameters are
     * used.
     */
    uint32_t    pkt_rate_low;
    uint32_t    rx_coalesce_usecs_low;
    uint32_t    rx_max_coalesced_frames_low;
    uint32_t    tx_coalesce_usecs_low;
    uint32_t    tx_max_coalesced_frames_low;

    /* When the packet rate is below pkt_rate_high but above
     * pkt_rate_low (both measured in packets per second) the
     * normal {rx,tx}_* coalescing parameters are used.
     */

    /* When the packet rate is (measured in packets per second)
     * is above pkt_rate_high, the {rx,tx}_*_high parameters are
     * used.
     */
    uint32_t    pkt_rate_high;
    uint32_t    rx_coalesce_usecs_high;
    uint32_t    rx_max_coalesced_frames_high;
    uint32_t    tx_coalesce_usecs_high;
    uint32_t    tx_max_coalesced_frames_high;

    /* How often to do adaptive coalescing packet rate sampling,
     * measured in seconds.  Must not be zero.
     */
    uint32_t    rate_sample_interval;
};

/* for configuring RX/TX ring parameters */
struct ethtool_ringparam {
    uint32_t    cmd;    /* ETHTOOL_{G,S}RINGPARAM */

    /* Read only attributes.  These indicate the maximum number
     * of pending RX/TX ring entries the driver will allow the
     * user to set.
     */
    uint32_t    rx_max_pending;
    uint32_t    rx_mini_max_pending;
    uint32_t    rx_jumbo_max_pending;
    uint32_t    tx_max_pending;

    /* Values changeable by the user.  The valid values are
     * in the range 1 to the "*_max_pending" counterpart above.
     */
    uint32_t    rx_pending;
    uint32_t    rx_mini_pending;
    uint32_t    rx_jumbo_pending;
    uint32_t    tx_pending;
};

/* for configuring link flow control parameters */
struct ethtool_pauseparam {
    uint32_t    cmd;    /* ETHTOOL_{G,S}PAUSEPARAM */

    /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
     * being true) the user may set 'autonet' here non-zero to have the
     * pause parameters be auto-negotiated too.  In such a case, the
     * {rx,tx}_pause values below determine what capabilities are
     * advertised.
     *
     * If 'autoneg' is zero or the link is not being auto-negotiated,
     * then {rx,tx}_pause force the driver to use/not-use pause
     * flow control.
     */
    uint32_t    autoneg;
    uint32_t    rx_pause;
    uint32_t    tx_pause;
};

#define ETH_GSTRING_LEN     32
enum ethtool_stringset {
    ETH_SS_TEST     = 0,
    ETH_SS_STATS,
    ETH_SS_PRIV_FLAGS,
    ETH_SS_NTUPLE_FILTERS,
    ETH_SS_FEATURES,
};

/* for passing string sets for data tagging */
struct ethtool_gstrings {
    uint32_t    cmd;        /* ETHTOOL_GSTRINGS */
    uint32_t    string_set; /* string set id e.c. ETH_SS_TEST, etc*/
    uint32_t    len;        /* number of strings in the string set */
    uint8_t data[0];
};

struct ethtool_sset_info {
    uint32_t    cmd;        /* ETHTOOL_GSSET_INFO */
    uint32_t    reserved;
    uint64_t    sset_mask;  /* input: each bit selects an sset to query */
    /* output: each bit a returned sset */
    uint32_t    data[0];    /* ETH_SS_xxx count, in order, based on bits
                   in sset_mask.  One bit implies one
                   uint32_t, two bits implies two
                   uint32_t's, etc. */
};

enum ethtool_test_flags {
    ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
    ETH_TEST_FL_FAILED  = (1 << 1), /* test passed / failed */
};

/* for requesting NIC test and getting results*/
struct ethtool_test {
    uint32_t    cmd;        /* ETHTOOL_TEST */
    uint32_t    flags;      /* ETH_TEST_FL_xxx */
    uint32_t    reserved;
    uint32_t    len;        /* result length, in number of u64 elements */
    uint64_t    data[0];
};

/* for dumping NIC-specific statistics */
struct ethtool_stats {
    uint32_t    cmd;        /* ETHTOOL_GSTATS */
    uint32_t    n_stats;    /* number of u64's being returned */
    uint64_t    data[0];
};

struct ethtool_perm_addr {
    uint32_t    cmd;        /* ETHTOOL_GPERMADDR */
    uint32_t    size;
    uint8_t data[0];
};

/* boolean flags controlling per-interface behavior characteristics.
 * When reading, the flag indicates whether or not a certain behavior
 * is enabled/present.  When writing, the flag indicates whether
 * or not the driver should turn on (set) or off (clear) a behavior.
 *
 * Some behaviors may read-only (unconditionally absent or present).
 * If such is the case, return EINVAL in the set-flags operation if the
 * flag differs from the read-only value.
 */
enum ethtool_flags {
    ETH_FLAG_TXVLAN     = (1 << 7), /* TX VLAN offload enabled */
    ETH_FLAG_RXVLAN     = (1 << 8), /* RX VLAN offload enabled */
    ETH_FLAG_LRO        = (1 << 15),    /* LRO is enabled */
    ETH_FLAG_NTUPLE     = (1 << 27),    /* N-tuple filters enabled */
    ETH_FLAG_RXHASH     = (1 << 28),
};

/* The following structures are for supporting RX network flow
 * classification and RX n-tuple configuration. Note, all multibyte
 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
 * be in network byte order.
 */

/**
 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
 * @ip4src: Source host
 * @ip4dst: Destination host
 * @psrc: Source port
 * @pdst: Destination port
 * @tos: Type-of-service
 *
 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
 */
struct ethtool_tcpip4_spec {
    uint32_t    ip4src;
    uint32_t    ip4dst;
    uint16_t    psrc;
    uint16_t    pdst;
    uint8_t    tos;
};

/**
 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
 * @ip4src: Source host
 * @ip4dst: Destination host
 * @spi: Security parameters index
 * @tos: Type-of-service
 *
 * This can be used to specify an IPsec transport or tunnel over IPv4.
 */
struct ethtool_ah_espip4_spec {
    uint32_t    ip4src;
    uint32_t    ip4dst;
    uint32_t    spi;
    uint8_t    tos;
};

#define ETH_RX_NFC_IP4  1

/**
 * struct ethtool_usrip4_spec - general flow specification for IPv4
 * @ip4src: Source host
 * @ip4dst: Destination host
 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
 * @tos: Type-of-service
 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
 * @proto: Transport protocol number; mask must be 0
 */
struct ethtool_usrip4_spec {
    uint32_t    ip4src;
    uint32_t    ip4dst;
    uint32_t    l4_4_bytes;
    uint8_t    tos;
    uint8_t    ip_ver;
    uint8_t    proto;
};


/**
 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
 * @size: On entry, the array size of the user buffer.  On return from
 *  %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table.
 * @ring_index: RX ring/queue index for each hash value
 */
struct ethtool_rxfh_indir {
    uint32_t    cmd;
    uint32_t    size;
    uint32_t    ring_index[0];
};

#define ETHTOOL_FLASH_MAX_FILENAME  128
enum ethtool_flash_op_type {
    ETHTOOL_FLASH_ALL_REGIONS   = 0,
};

/* for passing firmware flashing related parameters */
struct ethtool_flash {
    uint32_t    cmd;
    uint32_t    region;
    char    data[ETHTOOL_FLASH_MAX_FILENAME];
};

/* for returning and changing feature sets */

/**
 * struct ethtool_get_features_block - block with state of 32 features
 * @available: mask of changeable features
 * @requested: mask of features requested to be enabled if possible
 * @active: mask of currently enabled features
 * @never_changed: mask of features not changeable for any device
 */
struct ethtool_get_features_block {
    uint32_t    available;
    uint32_t    requested;
    uint32_t    active;
    uint32_t    never_changed;
};

/**
 * struct ethtool_gfeatures - command to get state of device's features
 * @cmd: command number = %ETHTOOL_GFEATURES
 * @size: in: number of elements in the features[] array;
 *       out: number of elements in features[] needed to hold all features
 * @features: state of features
 */
struct ethtool_gfeatures {
    uint32_t    cmd;
    uint32_t    size;
    struct ethtool_get_features_block features[0];
};

/**
 * struct ethtool_set_features_block - block with request for 32 features
 * @valid: mask of features to be changed
 * @requested: values of features to be changed
 */
struct ethtool_set_features_block {
    uint32_t    valid;
    uint32_t    requested;
};

/**
 * struct ethtool_sfeatures - command to request change in device's features
 * @cmd: command number = %ETHTOOL_SFEATURES
 * @size: array size of the features[] array
 * @features: feature change masks
 */
struct ethtool_sfeatures {
    uint32_t    cmd;
    uint32_t    size;
    struct ethtool_set_features_block features[0];
};

/*
 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
 * values of corresponding bits in features[].requested. Bits in .requested
 * not set in .valid or not changeable are ignored.
 *
 * Returns %EINVAL when .valid contains undefined or never-changable bits
 * or size is not equal to required number of features words (32-bit blocks).
 * Returns >= 0 if request was completed; bits set in the value mean:
 *   %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
 *  changeable (not present in %ETHTOOL_GFEATURES' features[].available)
 *  those bits were ignored.
 *   %ETHTOOL_F_WISH - some or all changes requested were recorded but the
 *      resulting state of bits masked by .valid is not equal to .requested.
 *      Probably there are other device-specific constraints on some features
 *      in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
 *      here as though ignored bits were cleared.
 *   %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
 *      compatibility functions. Requested offload state cannot be properly
 *      managed by kernel.
 *
 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
 * significant bit in features[0] fields. Empty strings mark undefined features.
 */
enum ethtool_sfeatures_retval_bits {
    ETHTOOL_F_UNSUPPORTED__BIT,
    ETHTOOL_F_WISH__BIT,
    ETHTOOL_F_COMPAT__BIT,
};

#define ETHTOOL_F_UNSUPPORTED   (1 << ETHTOOL_F_UNSUPPORTED__BIT)
#define ETHTOOL_F_WISH          (1 << ETHTOOL_F_WISH__BIT)
#define ETHTOOL_F_COMPAT        (1 << ETHTOOL_F_COMPAT__BIT)

/* CMDs currently supported */
#define ETHTOOL_GSET        0x00000001 /* Get settings. */
#define ETHTOOL_SSET        0x00000002 /* Set settings. */
#define ETHTOOL_GDRVINFO    0x00000003 /* Get driver info. */
#define ETHTOOL_GREGS       0x00000004 /* Get NIC registers. */
#define ETHTOOL_GWOL        0x00000005 /* Get wake-on-lan options. */
#define ETHTOOL_SWOL        0x00000006 /* Set wake-on-lan options. */
#define ETHTOOL_GMSGLVL     0x00000007 /* Get driver message level */
#define ETHTOOL_SMSGLVL     0x00000008 /* Set driver msg level. */
#define ETHTOOL_NWAY_RST    0x00000009 /* Restart autonegotiation. */
/* Get link status for host, i.e. whether the interface *and* the
 * physical port (if there is one) are up (ethtool_value). */
#define ETHTOOL_GLINK       0x0000000a
#define ETHTOOL_GEEPROM     0x0000000b /* Get EEPROM data */
#define ETHTOOL_SEEPROM     0x0000000c /* Set EEPROM data. */
#define ETHTOOL_GCOALESCE   0x0000000e /* Get coalesce config */
#define ETHTOOL_SCOALESCE   0x0000000f /* Set coalesce config. */
#define ETHTOOL_GRINGPARAM  0x00000010 /* Get ring parameters */
#define ETHTOOL_SRINGPARAM  0x00000011 /* Set ring parameters. */
#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
#define ETHTOOL_GRXCSUM     0x00000014 /* Get RX hw csum enable (ethtool_value) */
#define ETHTOOL_SRXCSUM     0x00000015 /* Set RX hw csum enable (ethtool_value) */
#define ETHTOOL_GTXCSUM     0x00000016 /* Get TX hw csum enable (ethtool_value) */
#define ETHTOOL_STXCSUM     0x00000017 /* Set TX hw csum enable (ethtool_value) */
#define ETHTOOL_GSG     0x00000018 /* Get scatter-gather enable
                        * (ethtool_value) */
#define ETHTOOL_SSG     0x00000019 /* Set scatter-gather enable
                        * (ethtool_value). */
#define ETHTOOL_TEST        0x0000001a /* execute NIC self-test. */
#define ETHTOOL_GSTRINGS    0x0000001b /* get specified string set */
#define ETHTOOL_PHYS_ID     0x0000001c /* identify the NIC */
#define ETHTOOL_GSTATS      0x0000001d /* get NIC-specific statistics */
#define ETHTOOL_GTSO        0x0000001e /* Get TSO enable (ethtool_value) */
#define ETHTOOL_STSO        0x0000001f /* Set TSO enable (ethtool_value) */
#define ETHTOOL_GPERMADDR   0x00000020 /* Get permanent hardware address */
#define ETHTOOL_GUFO        0x00000021 /* Get UFO enable (ethtool_value) */
#define ETHTOOL_SUFO        0x00000022 /* Set UFO enable (ethtool_value) */
#define ETHTOOL_GGSO        0x00000023 /* Get GSO enable (ethtool_value) */
#define ETHTOOL_SGSO        0x00000024 /* Set GSO enable (ethtool_value) */
#define ETHTOOL_GFLAGS      0x00000025 /* Get flags bitmap(ethtool_value) */
#define ETHTOOL_SFLAGS      0x00000026 /* Set flags bitmap(ethtool_value) */
#define ETHTOOL_GPFLAGS     0x00000027 /* Get driver-private flags bitmap */
#define ETHTOOL_SPFLAGS     0x00000028 /* Set driver-private flags bitmap */

#define ETHTOOL_GRXFH       0x00000029 /* Get RX flow hash configuration */
#define ETHTOOL_SRXFH       0x0000002a /* Set RX flow hash configuration */
#define ETHTOOL_GGRO        0x0000002b /* Get GRO enable (ethtool_value) */
#define ETHTOOL_SGRO        0x0000002c /* Set GRO enable (ethtool_value) */
#define ETHTOOL_GRXRINGS    0x0000002d /* Get RX rings available for LB */
#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
#define ETHTOOL_GRXCLSRULE  0x0000002f /* Get RX classification rule */
#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
#define ETHTOOL_FLASHDEV    0x00000033 /* Flash firmware to device */
#define ETHTOOL_RESET       0x00000034 /* Reset hardware */
#define ETHTOOL_SRXNTUPLE   0x00000035 /* Add an n-tuple filter to device */
#define ETHTOOL_GRXNTUPLE   0x00000036 /* Get n-tuple filters from device */
#define ETHTOOL_GSSET_INFO  0x00000037 /* Get string set info */
#define ETHTOOL_GRXFHINDIR  0x00000038 /* Get RX flow hash indir'n table */
#define ETHTOOL_SRXFHINDIR  0x00000039 /* Set RX flow hash indir'n table */

#define ETHTOOL_GFEATURES   0x0000003a /* Get device offload settings */
#define ETHTOOL_SFEATURES   0x0000003b /* Change device offload settings */

/* compatibility with older code */
#define SPARC_ETH_GSET      ETHTOOL_GSET
#define SPARC_ETH_SSET      ETHTOOL_SSET

/* Indicates what features are supported by the interface. */
#define SUPPORTED_10baseT_Half      (1 << 0)
#define SUPPORTED_10baseT_Full      (1 << 1)
#define SUPPORTED_100baseT_Half     (1 << 2)
#define SUPPORTED_100baseT_Full     (1 << 3)
#define SUPPORTED_1000baseT_Half    (1 << 4)
#define SUPPORTED_1000baseT_Full    (1 << 5)
#define SUPPORTED_Autoneg       (1 << 6)
#define SUPPORTED_TP            (1 << 7)
#define SUPPORTED_AUI           (1 << 8)
#define SUPPORTED_MII           (1 << 9)
#define SUPPORTED_FIBRE         (1 << 10)
#define SUPPORTED_BNC           (1 << 11)
#define SUPPORTED_10000baseT_Full   (1 << 12)
#define SUPPORTED_Pause         (1 << 13)
#define SUPPORTED_Asym_Pause        (1 << 14)
#define SUPPORTED_2500baseX_Full    (1 << 15)
#define SUPPORTED_Backplane     (1 << 16)
#define SUPPORTED_1000baseKX_Full   (1 << 17)
#define SUPPORTED_10000baseKX4_Full (1 << 18)
#define SUPPORTED_10000baseKR_Full  (1 << 19)
#define SUPPORTED_10000baseR_FEC    (1 << 20)
#define SUPPORTED_1000baseX_Half    (1 << 21)
#define SUPPORTED_1000baseX_Full    (1 << 22)

/* Indicates what features are advertised by the interface. */
#define ADVERTISED_10baseT_Half     (1 << 0)
#define ADVERTISED_10baseT_Full     (1 << 1)
#define ADVERTISED_100baseT_Half    (1 << 2)
#define ADVERTISED_100baseT_Full    (1 << 3)
#define ADVERTISED_1000baseT_Half   (1 << 4)
#define ADVERTISED_1000baseT_Full   (1 << 5)
#define ADVERTISED_Autoneg      (1 << 6)
#define ADVERTISED_TP           (1 << 7)
#define ADVERTISED_AUI          (1 << 8)
#define ADVERTISED_MII          (1 << 9)
#define ADVERTISED_FIBRE        (1 << 10)
#define ADVERTISED_BNC          (1 << 11)
#define ADVERTISED_10000baseT_Full  (1 << 12)
#define ADVERTISED_Pause        (1 << 13)
#define ADVERTISED_Asym_Pause       (1 << 14)
#define ADVERTISED_2500baseX_Full   (1 << 15)
#define ADVERTISED_Backplane        (1 << 16)
#define ADVERTISED_1000baseKX_Full  (1 << 17)
#define ADVERTISED_10000baseKX4_Full    (1 << 18)
#define ADVERTISED_10000baseKR_Full (1 << 19)
#define ADVERTISED_10000baseR_FEC   (1 << 20)
#define ADVERTISED_1000baseX_Half   (1 << 21)
#define ADVERTISED_1000baseX_Full   (1 << 22)

/* The following are all involved in forcing a particular link
 * mode for the device for setting things.  When getting the
 * devices settings, these indicate the current mode and whether
 * it was foced up into this mode or autonegotiated.
 */

/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
#define SPEED_10        10
#define SPEED_100       100
#define SPEED_1000      1000
#define SPEED_2500      2500
#define SPEED_10000     10000

/* Duplex, half or full. */
#define DUPLEX_HALF     0x00
#define DUPLEX_FULL     0x01

/* Which connector port. */
#define PORT_TP         0x00
#define PORT_AUI        0x01
#define PORT_MII        0x02
#define PORT_FIBRE      0x03
#define PORT_BNC        0x04
#define PORT_DA         0x05
#define PORT_NONE       0xef
#define PORT_OTHER      0xff

/* Which transceiver to use. */
#define XCVR_INTERNAL       0x00
#define XCVR_EXTERNAL       0x01
#define XCVR_DUMMY1     0x02
#define XCVR_DUMMY2     0x03
#define XCVR_DUMMY3     0x04

/* Enable or disable autonegotiation.  If this is set to enable,
 * the forced link modes above are completely ignored.
 */
#define AUTONEG_DISABLE     0x00
#define AUTONEG_ENABLE      0x01

/* Mode MDI or MDI-X */
#define ETH_TP_MDI_INVALID  0x00
#define ETH_TP_MDI      0x01
#define ETH_TP_MDI_X        0x02

/* Wake-On-Lan options. */
#define WAKE_PHY        (1 << 0)
#define WAKE_UCAST      (1 << 1)
#define WAKE_MCAST      (1 << 2)
#define WAKE_BCAST      (1 << 3)
#define WAKE_ARP        (1 << 4)
#define WAKE_MAGIC      (1 << 5)
#define WAKE_MAGICSECURE    (1 << 6) /* only meaningful if WAKE_MAGIC */

/* L2-L4 network traffic flow types */
#define TCP_V4_FLOW 0x01    /* hash or spec (tcp_ip4_spec) */
#define UDP_V4_FLOW 0x02    /* hash or spec (udp_ip4_spec) */
#define SCTP_V4_FLOW    0x03    /* hash or spec (sctp_ip4_spec) */
#define AH_ESP_V4_FLOW  0x04    /* hash only */
#define TCP_V6_FLOW 0x05    /* hash only */
#define UDP_V6_FLOW 0x06    /* hash only */
#define SCTP_V6_FLOW    0x07    /* hash only */
#define AH_ESP_V6_FLOW  0x08    /* hash only */
#define AH_V4_FLOW  0x09    /* hash or spec (ah_ip4_spec) */
#define ESP_V4_FLOW 0x0a    /* hash or spec (esp_ip4_spec) */
#define AH_V6_FLOW  0x0b    /* hash only */
#define ESP_V6_FLOW 0x0c    /* hash only */
#define IP_USER_FLOW    0x0d    /* spec only (usr_ip4_spec) */
#define IPV4_FLOW   0x10    /* hash only */
#define IPV6_FLOW   0x11    /* hash only */
#define ETHER_FLOW  0x12    /* spec only (ether_spec) */

/* L3-L4 network traffic flow hash options */
#define RXH_L2DA    (1 << 1)
#define RXH_VLAN    (1 << 2)
#define RXH_L3_PROTO    (1 << 3)
#define RXH_IP_SRC  (1 << 4)
#define RXH_IP_DST  (1 << 5)
#define RXH_L4_B_0_1    (1 << 6) /* src port in case of TCP/UDP/SCTP */
#define RXH_L4_B_2_3    (1 << 7) /* dst port in case of TCP/UDP/SCTP */
#define RXH_DISCARD (1U << 31)

#define RX_CLS_FLOW_DISC    0xffffffffffffffffULL

/* Reset flags */
/* The reset() operation must clear the flags for the components which
 * were actually reset.  On successful return, the flags indicate the
 * components which were not reset, either because they do not exist
 * in the hardware or because they cannot be reset independently.  The
 * driver must never reset any components that were not requested.
 */
enum ethtool_reset_flags {
    /* These flags represent components dedicated to the interface
     * the command is addressed to.  Shift any flag left by
     * ETH_RESET_SHARED_SHIFT to reset a shared component of the
     * same type.
     */
    ETH_RESET_MGMT      = 1 << 0,   /* Management processor */
    ETH_RESET_IRQ       = 1 << 1,   /* Interrupt requester */
    ETH_RESET_DMA       = 1 << 2,   /* DMA engine */
    ETH_RESET_FILTER    = 1 << 3,   /* Filtering/flow direction */
    ETH_RESET_OFFLOAD   = 1 << 4,   /* Protocol offload */
    ETH_RESET_MAC       = 1 << 5,   /* Media access controller */
    ETH_RESET_PHY       = 1 << 6,   /* Transceiver/PHY */
    ETH_RESET_RAM       = 1 << 7,   /* RAM shared between
                         * multiple components */

    ETH_RESET_DEDICATED = 0x0000ffff,   /* All components dedicated to
                         * this interface */
    ETH_RESET_ALL       = 0xffffffff,   /* All components used by this
                         * interface, even if shared */
};
#define ETH_RESET_SHARED_SHIFT  16
